home *** CD-ROM | disk | FTP | other *** search
/ Aminet 5 / Aminet 5 - March 1995.iso / Aminet / util / cli / KeyComp.lha / KeyComp.doc < prev    next >
Text File  |  1994-12-12  |  4KB  |  130 lines
  1.  
  2.                              MJSoft's Keymap Tools
  3.  
  4.                  (c) 1994 Martin Mares, MJSoft System Software
  5.  
  6. ================================================================================
  7.  
  8.  
  9. Preface
  10. =======
  11.  
  12.    KeyComp,  KeyRes, their documentation and ss.library are Copyright (c) Martin
  13. Mares, MJSoft System Software, Prague, Czech Republic.
  14.  
  15.    This  archive  can  be  freely redistributed, as long as all of its files are
  16. included   in   their   original   form  without  any  additions,  deletions  or
  17. modifications,  and  no more than a nominal fee is charged for its distribution.
  18. All  copyright notices in the programs and accompanying documentation files must
  19. remain  on  their  places.  Also '.displayme' and other similar files may not be
  20. added.  This is generally known as FREEWARE.
  21.  
  22.    This  software  is  provided  "AS  IS"  without  warranty of any kind, either
  23. expressed  or  implied.   The author is not responsible for any damage caused by
  24. it.
  25.  
  26.  
  27. Introduction
  28. ============
  29.  
  30.    Keymaps, keymaps, keymaps. Problems, problems, problems.
  31.  
  32.    There is no sufficiently smart tool allowing complex manipulation with Amiga
  33. keymap files. This package contains KeyRes -- the keymap resourcer that converts
  34. a keymap to human-readable source file and KeyComp -- the keymap compiler that
  35. takes such a source and compiles it to standard binary keymap file.
  36.  
  37.    Both KeyComp and KeyRes are pure and can be made resident.
  38.  
  39.  
  40. Requirements
  41. ============
  42.  
  43.    - These tools requires Kickstart 2.04 or higher and the ss.library version
  44. 5.0 or higher (included in this archive, see SSLib<???>.lha on the AmiNet for
  45. full distribution).
  46.  
  47.  
  48. KeyRes
  49. ======
  50.  
  51. Syntax: KeyRes <from> [<to>]
  52.  
  53.   from - name of keymap to be disassembled. It can be stored in RAM or on
  54.          a disk.
  55.     to - name of file to store the output to. Default is <from>.kms.
  56.  
  57. Keymap source file is a sequence of key definition blocks, which have the
  58. following syntax:
  59.  
  60. [<KEY TYPE>] KEY <NAME> [{<QUAL>}] [CAPS]
  61. <followed by several lines of key meanings>
  62.  
  63.   Key type - can be DEAD, STRING or empty
  64.       Name - key name (described below)
  65.       Qual - qualifiers affecting processing of this key (SHIFT, ALT, CTRL)
  66.       CAPS - set if CAPS LOCK act as SHIFT
  67.  
  68. Key names:
  69.  
  70. TILDE, ONE, TWO, THREE, FOUR, FIVE, SIX, SEVEN, EIGHT, NINE, ZERO, MINUS,
  71. EQUAL, BACKSLASH, K0, Q, W, E, R, T, Y, U, I, O, P, LBRACK, RBRACK, K1, K2,
  72. K3, A, S, D, F, G, H, J, K, L, SEMICOLON, APOSTROPHE, HASH, K4, K5, K6,
  73. LESS, Z, X, C, V, B, N, M, COMMA, DOT, SLASH, KDOT, K7, K8, K9, SPACE,
  74. BACKSPACE, TAB, KENTER, ENTER, ESC, DEL, KMINUS, UP, DOWN, RIGHT, LEFT, F1,
  75. F2, F3, F4, F5, F6, F7, F8, F9, F10, KLBRACK, KRBRACK, KSLASH, KASTERISK,
  76. KPLUS, HELP, LSHIFT, RSHIFT, CAPSLOCK, CONTROL, LALT, RALT, LAMIGA, RAMIGA.
  77.  
  78. Key meaning:
  79.  
  80. Normal keys        [<QUAL>] '<character>' | <character code>
  81.                |        |
  82.                |        *--- character generated by this key
  83.                |
  84.                *-- qualifiers of this meaning (SHIFT,ALT,CTRL)
  85.                |
  86. String keys        [<QUAL>] "<string>"
  87.                |         |
  88.                |         *--- string generated by this key
  89.                |            use "" or \" for double quotes
  90.                |            use \cc for hex. char. code
  91.                |
  92.                |
  93. Dead keys        [<QUAL>] '<character>' | <character code>
  94.                |        |
  95.                |        *-- code of meaning not affected
  96.                |            by prefix (dead) keys
  97.             [<QUAL>] PREFIX <num>
  98.                |          |
  99.                |          *-- # of prefix generated by this key
  100.             [<QUAL>] PREFIX <p1>,<p2>
  101.                |   used if prefix has to be pressed twice to get
  102.                |   some other meaning. In this case, the final
  103.                |   prefix code is <p1_of_first_prefix> *
  104.                |   <p2_of_second_prefix> + <p1_of_second_prefix>.
  105.             [<QUAL>] MOD { '<char>' | <code> , ... }
  106.                     |
  107.                     *-- meaning modified by dead keys
  108.                         contains list of characters -
  109.                         - for each prefix code one char.
  110.  
  111.  
  112. KeyComp
  113. =======
  114.  
  115.    Keymap compiler - does reverse process to KeyRes. Useful for creating
  116. of keymaps in non-interactive way.
  117.  
  118. Syntax: KeyComp <source> [<dest>]
  119.  
  120.    source - source file (.kms is appended if there's no extension in it)
  121.      dest - destination file (if omitted, source file name without extension
  122.         is substituted)
  123.  
  124.  
  125. Notes
  126. =====
  127.  
  128.    Send suggestions, flames and bug reports to <mjsoft@k332.feld.cvut.cz>.
  129.  
  130.